Hybris UX Api
TMF639 - patchLogicalResource
This operation allows to reserve or release from the inventory for below use cases:
- Postpaid MSISDN, eSIM(ICCID)
- Prepaid MSISDN, eSIM(ICCID)
URL
http://[localhost]:[port]/ecom-ux/v1/{businessId}/logicalResource/{id}URL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | String | 2 letter ISO 3166 country code (PA) identifying the business unit. | Y |
| id | string | Resource identification number for which needs to patch the data. | Y |
Headers
| name | type | description | required |
|---|---|---|---|
| client-id | string | The client-id identifying the channel. Minimum characters: 5 | Y |
| client-secret | string | Password associated with the client-id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | N |
Data Model - Request
| field name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A, conditionallyMandatory-C/M) |
|---|---|---|---|
| resourceStatus | String | Tracks the lifecycle status of the resource, such as planning, installing, operating, retiring and so on. Possible values for PA: available, reserved | Y (PA) |
| @type | String | type of the concrete resource. Possible value for PA: MSISDN, ESIM | Y (PA) |
| relatedParty[].id | String | unique identifier of Customer | Y (PA) |
| relatedParty[].name | String | name of Customer | Y (PA only for PREPAID usecase) |
| relatedParty[].role | String | Role played by the related party | C/M (PA only for POSTPAID ESIM usecase) |
| relatedParty[].'@referredType' | String | Defines the type of the 'relatedParty[].id' Eg: Customer, Employee | Y (PA) |
| resourceCharacteristic[].name | String | Name of the characteristic Possible values for PA: SERVICE | Y (PA) |
| resourceCharacteristic[].valueType | String | Data type of the value of the characteristic | Y (PA) |
| resourceCharacteristic[].value | String | Value of the characteristic Possible values for PA: POSTPAID, PREPAID | Y (PA) |
relatedParty subResource -Data Model
| field name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A, conditionalMandatory- C/M) | examples |
|---|---|---|---|---|
| relatedParty[].'@referredType' == "Customer" | String | Customer Name | C/M (PA) | PA(ESIM): { "id": "Lakshmi", "@referredType" : "Customer" } |
| relatedParty[].'@referredType' == "Employee" | String | Employee number | C/M (PA only for POSTPAID) | PA(MSISDN): { "id": "<**>", "@referredType" : "Employee" } PA(ESIM): { "id": "<**>", "role": "authorizer", "@referredType" : "Employee" } |
resourceCharacteristic subResource -Data Model
| field name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| resourceCharacteristic[].name == "SERVICE" | String | Type of the Service Possible Value for PA: POSTPAID,PREPAID | Y (PA only for POSTPAID) | PA(MSISDN & ESIM): { "name": "SERVICE", "valueType": "string", "value": "POSTPAID" } |
| resourceCharacteristic[].name == "NumberArea" | String | Type of the NumberArea Example Value for PA: MOV | Y (PA only for POSTPAID) | PA(MSISDN): { "name": "NumberArea", "valueType": "string", "value": "MOV" } |
| resourceCharacteristic[].name == "BillingAccount.id" | String | Customer billingAccount | Y (PA only for POSTPAID) | PA(MSISDN): { "name": "BillingAccount.id", "valueType": "string", "value": "358155960000" } |
Data Model - Response
| field name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A, conditionalMandatory- C/M) |
|---|---|---|---|
| id | String | Identifier of an instance of the resource. Required to be unique within the resource type. | Y (PA) |
| href | String | Hyperlink reference | Y (PA only for POSTPAID) |
| resourceStatus | String | Tracks the lifecycle status of the resource, such as planning, installing, operating, retiring and so on. Possible values for PA are: available, reserved | Y (PA) |
| @type | String | type of the concrete resource. Possible value for PA: MSISDN, ESIM | Y (PA only for POSTPAID) |
| relatedParty[].id | String | unique identifier | Y (PA only for POSTPAID) |
| relatedParty[].role | String | Role played by the related party | C/M (PA : ESIM only for POSTPAID) |
| relatedParty[].'@referredType' | String | The actual type of the target instance when needed for disambiguation. | Y (PA only for POSTPAID) |
| resourceCharacteristic[].name | String | Name of the characteristic | Y (PA only for POSTPAID) |
| resourceCharacteristic[].valueType | String | Data type of the value of the characteristic | Y (PA only for POSTPAID) |
| resourceCharacteristic[].value | String | Value of the characteristic | Y (PA only for POSTPAID) |
| resourceType | String | Type of the concrete resource. Possible value for PA: MSISDN, ESIM | Y (PA only for PREPAID) |
relatedParty subResource -Data Model
| field name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A,conditionalMandatory- C/M) | examples |
|---|---|---|---|---|
| relatedParty[].'@referredType' == "Customer" | String | Customer Name | Y (PA only for POSTPAID) | PA(ESIM): { "id": "Lakshmi", "@referredType" : "Customer" } |
| relatedParty[].'@referredType' == "Employee" | String | Employee number | C/M (PA only for POSTPAID) | PA(MSISDN): { "id": "<*>", "@referredType" : "Employee" } PA(ESIM): { "id": "<**>", "role": "authorizer", "@referredType" : "Employee" } |
resourceCharacteristic subResource -Data Model
| field name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| resourceCharacteristic[].name == "SERVICE" | String | Type of the Service Possible Value for PA: POSTPAID | Y (PA) | PA(MSISDN & ESIM): { "name": "SERVICE", "valueType": "string", "value": "POSTPAID" } |
| resourceCharacteristic[].name == "NumberArea" | String | Type of the NumberArea Example Value for PA: MOV | Y (PA) | PA(MSISDN): { "name": "NumberArea", "valueType": "string", "value": "MOV" } |
| resourceCharacteristic[].name == "BillingAccount.id" | String | Customer billingAccount | Y (PA) | PA(MSISDN): { "name": "BillingAccount.id", "valueType": "string", "value": "358155960000" } |
Key considerations
PA Implementation
Service number(MSISDN) usecase
POSTPAID
- As this is implemented for mobile postpaid customers, if resourceCharacteristic[].name == "SERVICE" then value should be "POSTPAID".
- For MSISDN resourceCharacteristic[].name == "NumberArea" ,For FAST TRACK provisioning, the following value="MOV" is currently working in the Non-Prod environment. However, for the PROD instance, the channel must discuss and finalize the appropriate value with the business, which then need to be configured in the Liberate PROD instance.
- For MSISDN resourceCharacteristic[].name == "BillingAccount.id" then value should be customer billingAccount.
- To reserve/release a MSISDN, set the @type to MSISDN.
- To reserve a MSISDN, set the resourceStatus to "reserved".
- To release a MSISDN, set the resourceStatus to "available".
- If relatedParty[].'@referredType' == "Employee", the following relatedParty[].id value we need to pass employee code. However, for the PROD instance, the channel must discuss and finalize the appropriate values with the business, which then need to be configured in the Liberate PROD instance.
- For reserve/release MSISDN, refer to note section for API specification.PREPAID
- As this is implemented for mobile prepaid customers, if resourceCharacteristic[].name == "SERVICE" then value should be "PREPAID".
- To reserve/release a MSISDN, set the @type to MSISDN.
- To reserve a MSISDN, set the resourceStatus to "reserved".
- To release a MSISDN, set the resourceStatus to "available".
- If relatedParty[].'@referredType' == "Customer" then Customer Name should be passed in relatedParty[].name
- For reserve/release MSISDN, refer to note section for API specification.eSIM (ICCID) usecase
POSTPAID
- As this is implemented for mobile postpaid customers, if resourceCharacteristic[].name == "SERVICE" then value should be "POSTPAID".
- To reserve/release a eSIM(ICCID), set the @type to ESIM.
- To reserve a eSIM(ICCID), set the resourceStatus to "reserved".
- To release a eSIM(ICCID), set the resourceStatus to "available".
- If relatedParty[].'@referredType' == "Employee" and relatedParty[].role == "authorizer" are given then employee number should be passed in relatedParty[].id
- If relatedParty[].'@referredType' == "Customer" then Customer billing account id should be passed in relatedParty[].id
- For reserve/release eSIM(ICCID), refer to note section for API specification.PREPAID
- As this is implemented for mobile prepaid customers, if resourceCharacteristic[].name == "SERVICE" then value should be "PREPAID".
- To reserve/release a eSIM, set the @type to eSIM.
- To reserve a eSIM, set the resourceStatus to "reserved".
- To release a eSIM, set the resourceStatus to "available".
- If relatedParty[].'@referredType' == "Customer" then Customer Name should be passed in relatedParty[].name
- For reserve/release eSIM, refer to note section for API specification.Note : For request and response examples please refer to this URL Patch LogicalResource Specification